# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Burger Shop 2 Template

game: Burger Shop 2
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

Burger Shop 2:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  five_star_mode:
    # When enabled, a Story Level check is only sent after the player earns all 5 stars on that level.
    # When disabled, any completion (regardless of star count) sends the check.
    'false': 0
    'true': 50

  starter_recipes:
    # When enabled, one random item from each of the following pools is placed into a starter location
    # and added to the player's inventory after completing any story level: a large side, a large soda,
    # an ice cream flavor, a breakfast drink, a cereal, a toasted item, a soup, and a dinner meat.
    # Customer orders will include these items from early on, making gameplay immediately more demanding.
    'false': 50
    'true': 0

  bonus_recipes:
    # When enabled, up to 16 additional trap items are added to the item pool as filler-replacements,
    # drawn randomly from: Small Vanilla/Chocolate/Strawberry Ice Cream, Small Vanilla/Chocolate/Strawberry
    # Milkshake, Small Vanilla Cola Float, Chicken Sandwich w/Cheese, Hamburger w/Bacon,
    # Quadruple Cheeseburger, Quadruple Bacon Cheeseburger, Mug Milk, Plain Pasta, and Dry
    # Flakes/Fruity Os/Oatmeal Bowl.
    # Any customer who could order a similar item
    # will be able to order the bonus version once it is unlocked.
    'false': 0
    'true': 50

  start_with_lollipops:
    # When enabled, Lollipops are added to the player's starting inventory. This is recommended
    # when Five Star Mode is enabled, otherwise the late-game will be very difficult.
    'false': 0
    'true': 50

  start_with_burgerbot:
    # When enabled, BurgerBot is added to the player's starting inventory. This can make late-game
    # levels easier when Five Star Mode is enabled.
    'false': 50
    'true': 0

  customer_slots:
    # Forces every story level to use the same number of customer slots — the positions in the
    # queue that can hold a waiting customer at once. More slots means more simultaneous orders
    # and greater difficulty.
    # 
    # If more than 4 customer slots are being used, expect to see a great difficulty spike in the late-game.
    # 
    # Leave this at "vanilla" or 0 to keep each level's original count. Any value from 2 to 9 overrides every level, including
    # the ones that specify their own count.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 2
    # Maximum value is 9
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-2-9: 0 # random value between 2 and 9
    vanilla: 50 # equivalent to 0

  character_randomization:
    # Randomizes which customer characters show up in each level. Every level keeps the same
    # total number of customers.
    # 
    # vanilla: each level uses its original cast.
    # 
    # shuffle_groups: each group of customers becomes a different character of the same size,
    # so "4 Sumo, 4 Clown" might become "4 Hippy, 4 Punk". Levels keep their original shape.
    # 
    # randomize_counts: only the level's customer total is preserved. Both the number of
    # characters and how many of each are re-rolled, so "4 Sumo, 4 Clown" could become
    # "8 Hippy" or "2 Punk, 1 Skater, 3 Mimic, 2 Cowboy".
    vanilla: 50
    shuffle_groups: 0
    randomize_counts: 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
